\name{DotStack-class}
\Rdversion{1.1}
\docType{class}
\alias{DotStack-class}

\title{Class "DotStack"}
\description{
This is a formal S4 class designed to hold all the information related to a stacked dot plot.
}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("DotStack", ...)}.
This class is not meant to be created directly by the user.  It is typically created in the process of making a stacked dot plot (see \code{\link{StackedDots}}) by a call to \code{\link{link}} which handles all the necessary mappings.
}

\section{Slots}{
  \describe{
    \item{\code{.Data}:}{Object of class \code{"list"} general}
    \item{\code{original}:}{Object of class \code{"numeric"}, this contains the \emph{original} values before any cleaning.}
    \item{\code{name}:}{Object of class \code{"character"}, the name of the primary variable to be plotted.}
    \item{\code{x}:}{Object of class \code{"numeric"}, the x coordinates corresponding to the original data after being assigned to a stack.  All points in a stack will have identical x coordinates.}
    \item{\code{y}:}{Object of class \code{"numeric"}, the y coordinates corresponding to the original data after being assigned to a stack, used to avoid overplotting in a stack.}
    \item{\code{color}:}{Object of class \code{"ANY"}, controls the color of the dots.  Either a vector the same length as \code{original} giving the colors for each dot, or a single value to use for all dots.}
    \item{\code{shape}:}{Object of class \code{"ANY"}, this is currently unimplemented in any of the methods.  Eventually it will be similar to \code{color} and will allow different shapes (e.g., dots, squares, triangles) to be used.}
    \item{\code{key}:}{Object of class \code{"integer"}, this key is generated automatically and is used to map the xy coordinates used in the stacks back to the original data values.}
    \item{\code{ok}:}{Object of class \code{"integer"}, a vector indicating which values of \code{original} are non-missing.}
    \item{\code{h}:}{Object of class \code{"numeric"}, the value used for the \code{h} parameter when calculating the stacks and also sets the radii of the dots to be plotted.}
  }
}

\section{Extends}{
Class \code{"\linkS4class{list}"}, from data part.
Class \code{"\linkS4class{vector}"}, by class "list", distance 2.
}

\author{Joshua Wiley, \url{http://joshuawiley.com/}}

\seealso{
See Also as \code{\link{StackedDots}}
}

\examples{
showClass("DotStack")
}

\keyword{classes}
